/*
 * Copyright (C) 2009 M. Hautle.
 * 
 * This file is part of TrackedBean.
 * 
 * TrackedBean is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
 * Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 * 
 * TrackedBean is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License along with TrackedBean. If not, see
 * <http://www.gnu.org/licenses/>.
 */
package ch.trackedbean.validator.defaultValidators;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
import ch.trackedbean.validator.annotations.*;

/**
 * Annotation used to ensure that a value follows a given regular expression.
 * 
 * @author M. Hautle
 */
@Documented
@Target( { METHOD, FIELD })
@Retention(RUNTIME)
@BeanPropertyValidator(RegexValidator.class)
public @interface Regex {
	/** The method name of {@link #value()}. */
	public static final String ATTR_VALUE = "value";

	/** The method name of {@link #flags()}. */
	public static final String ATTR_FLAGS = "flags";

	/** The method name of {@link #message()}. */
	public static final String ATTR_MESSAGE = "message";

	/** The default value of {@link #message()}. */
	public static final String DEFAULT_MESSAGE = "wrong.syntax";

	/** The regular expression. */
	String value();

	/** Regular expression processing flags. */
	int flags() default 0;

	/** The message to return if the value is invalid. */
	String message() default DEFAULT_MESSAGE;
}
